<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="UChar.html">
<link rel="next" href="Unzip.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Base64" rel="Chapter" href="Base64.html">
<link title="BitSet" rel="Chapter" href="BitSet.html">
<link title="Dllist" rel="Chapter" href="Dllist.html">
<link title="DynArray" rel="Chapter" href="DynArray.html">
<link title="Enum" rel="Chapter" href="Enum.html">
<link title="ExtArray" rel="Chapter" href="ExtArray.html">
<link title="ExtHashtbl" rel="Chapter" href="ExtHashtbl.html">
<link title="ExtLib" rel="Chapter" href="ExtLib.html">
<link title="ExtList" rel="Chapter" href="ExtList.html">
<link title="ExtString" rel="Chapter" href="ExtString.html">
<link title="Global" rel="Chapter" href="Global.html">
<link title="IO" rel="Chapter" href="IO.html">
<link title="OptParse" rel="Chapter" href="OptParse.html">
<link title="Option" rel="Chapter" href="Option.html">
<link title="PMap" rel="Chapter" href="PMap.html">
<link title="RefList" rel="Chapter" href="RefList.html">
<link title="Std" rel="Chapter" href="Std.html">
<link title="UChar" rel="Chapter" href="UChar.html">
<link title="UTF8" rel="Chapter" href="UTF8.html">
<link title="Unzip" rel="Chapter" href="Unzip.html"><title>UTF8</title>
</head>
<body>
<div class="navbar"><a class="pre" href="UChar.html" title="UChar">Previous</a>
&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;<a class="post" href="Unzip.html" title="Unzip">Next</a>
</div>
<h1>Module <a href="type_UTF8.html">UTF8</a></h1>
<pre><span class="keyword">module</span> UTF8: <code class="code">sig</code> <a href="UTF8.html">..</a> <code class="code">end</code></pre><div class="info">
UTF-8 encoded Unicode strings. 
<p>

   The Module for UTF-8 encoded Unicode strings.<br>
</div>
<hr width="100%">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = <code class="type">string</code> </pre>
<div class="info">
UTF-8 encoded Unicode strings. the type is normal string.<br>
</div>

<pre><span id="EXCEPTIONMalformed_code"><span class="keyword">exception</span> Malformed_code</span></pre>
<pre><span id="VALvalidate"><span class="keyword">val</span> validate</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> unit</code></pre><div class="info">
<code class="code">validate s</code>
   Succeeds if s is valid UTF-8, otherwise raises Malformed_code.
   Other functions assume strings are valid UTF-8, so it is prudent
   to test their validity for strings from untrusted origins.<br>
</div>
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> int -> <a href="UChar.html#TYPEuchar">UChar.uchar</a></code></pre><div class="info">
<code class="code">get s n</code> returns <code class="code">n</code>-th Unicode character of <code class="code">s</code>.
   The call requires O(n)-time.<br>
</div>
<pre><span id="VALinit"><span class="keyword">val</span> init</span> : <code class="type">int -> (int -> <a href="UChar.html#TYPEuchar">UChar.uchar</a>) -> <a href="UTF8.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">init len f</code> 
   returns a new string which contains <code class="code">len</code> Unicode characters.
   The i-th Unicode character is initialized by <code class="code">f i</code><br>
</div>
<pre><span id="VALlength"><span class="keyword">val</span> length</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> int</code></pre><div class="info">
<code class="code">length s</code> returns the number of Unicode characters contained in s<br>
</div>
<pre><span id="TYPEindex"><span class="keyword">type</span> <code class="type"></code>index</span> = <code class="type">int</code> </pre>
<div class="info">
Positions in the string represented by the number of bytes from the head.
   The location of the first character is <code class="code">0</code><br>
</div>

<pre><span id="VALnth"><span class="keyword">val</span> nth</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> int -> <a href="UTF8.html#TYPEindex">index</a></code></pre><div class="info">
<code class="code">nth s n</code> returns the position of the <code class="code">n</code>-th Unicode character. 
   The call requires O(n)-time<br>
</div>
<pre><span id="VALlast"><span class="keyword">val</span> last</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> <a href="UTF8.html#TYPEindex">index</a></code></pre><div class="info">
The position of the head of the last Unicode character.<br>
</div>
<pre><span id="VALlook"><span class="keyword">val</span> look</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> <a href="UTF8.html#TYPEindex">index</a> -> <a href="UChar.html#TYPEuchar">UChar.uchar</a></code></pre><div class="info">
<code class="code">look s i</code>
   returns the Unicode character of the location <code class="code">i</code> in the string <code class="code">s</code>.<br>
</div>
<pre><span id="VALsubstring"><span class="keyword">val</span> substring</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> int -> int -> <a href="UTF8.html#TYPEt">t</a></code></pre><div class="info">
<code class="code">substring s i len</code> returns the substring made of the Unicode locations <code class="code">i</code> to <code class="code">i + len - 1</code> inclusive.
   The string is always copied<br>
</div>
<pre><span id="VALout_of_range"><span class="keyword">val</span> out_of_range</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> <a href="UTF8.html#TYPEindex">index</a> -> bool</code></pre><div class="info">
<code class="code">out_of_range s i</code>
   tests whether <code class="code">i</code> is a position inside of <code class="code">s</code>.<br>
</div>
<pre><span id="VALcompare_index"><span class="keyword">val</span> compare_index</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> <a href="UTF8.html#TYPEindex">index</a> -> <a href="UTF8.html#TYPEindex">index</a> -> int</code></pre><div class="info">
<code class="code">compare_index s i1 i2</code> returns
   a value &lt; 0 if <code class="code">i1</code> is the position located before <code class="code">i2</code>, 
   0 if <code class="code">i1</code> and <code class="code">i2</code> points the same location,
   a value &gt; 0 if <code class="code">i1</code> is the position located after <code class="code">i2</code>.<br>
</div>
<pre><span id="VALnext"><span class="keyword">val</span> next</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> <a href="UTF8.html#TYPEindex">index</a> -> <a href="UTF8.html#TYPEindex">index</a></code></pre><div class="info">
<code class="code">next s i</code>
   returns the position of the head of the Unicode character
   located immediately after <code class="code">i</code>. 
   If <code class="code">i</code> is inside of <code class="code">s</code>, the function always successes.
   If <code class="code">i</code> is inside of <code class="code">s</code> and there is no Unicode character after <code class="code">i</code>,
   the position outside <code class="code">s</code> is returned.  
   If <code class="code">i</code> is not inside of <code class="code">s</code>, the behaviour is unspecified.<br>
</div>
<pre><span id="VALprev"><span class="keyword">val</span> prev</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> <a href="UTF8.html#TYPEindex">index</a> -> <a href="UTF8.html#TYPEindex">index</a></code></pre><div class="info">
<code class="code">prev s i</code>
   returns the position of the head of the Unicode character
   located immediately before <code class="code">i</code>. 
   If <code class="code">i</code> is inside of <code class="code">s</code>, the function always successes.
   If <code class="code">i</code> is inside of <code class="code">s</code> and there is no Unicode character before <code class="code">i</code>,
   the position outside <code class="code">s</code> is returned.  
   If <code class="code">i</code> is not inside of <code class="code">s</code>, the behaviour is unspecified.<br>
</div>
<pre><span id="VALmove"><span class="keyword">val</span> move</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> <a href="UTF8.html#TYPEindex">index</a> -> int -> <a href="UTF8.html#TYPEindex">index</a></code></pre><div class="info">
<code class="code">move s i n</code>
   returns <code class="code">n</code>-th Unicode character after <code class="code">i</code> if n &gt;= 0,
   <code class="code">n</code>-th Unicode character before <code class="code">i</code> if n &lt; 0.
   If there is no such character, the result is unspecified.<br>
</div>
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">(<a href="UChar.html#TYPEuchar">UChar.uchar</a> -> unit) -> <a href="UTF8.html#TYPEt">t</a> -> unit</code></pre><div class="info">
<code class="code">iter f s</code>
   applies <code class="code">f</code> to all Unicode characters in <code class="code">s</code>.  
   The order of application is same to the order 
   of the Unicode characters in <code class="code">s</code>.<br>
</div>
<pre><span id="VALcompare"><span class="keyword">val</span> compare</span> : <code class="type"><a href="UTF8.html#TYPEt">t</a> -> <a href="UTF8.html#TYPEt">t</a> -> int</code></pre><div class="info">
Code point comparison by the lexicographic order.
   <code class="code">compare s1 s2</code> returns
   a positive integer if <code class="code">s1</code> &gt; <code class="code">s2</code>,
   0 if <code class="code">s1</code> = <code class="code">s2</code>,
   a negative integer if <code class="code">s1</code> &lt; <code class="code">s2</code>.<br>
</div>
<pre><span class="keyword">module</span> <a href="UTF8.Buf.html">Buf</a>: <code class="code">sig</code> <a href="UTF8.Buf.html">..</a> <code class="code">end</code></pre><div class="info">
Buffer module for UTF-8 strings
</div>
</body></html>